Skip to content

Comments

Clarify the docs for newcomers more#84

Merged
adam-fowler merged 8 commits intomainfrom
jo/clarifications
Mar 18, 2025
Merged

Clarify the docs for newcomers more#84
adam-fowler merged 8 commits intomainfrom
jo/clarifications

Conversation

@Joannis
Copy link
Member

@Joannis Joannis commented Mar 10, 2025

No description provided.

@Joannis Joannis requested a review from adam-fowler March 10, 2025 15:06
@@ -0,0 +1,21 @@
# JSON Support

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need a separate page just for JSON?
Perhaps we can change the byline for the Encoding and Decoding article to make it clearer that it is the how you decode JSON data.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

eg "Support for decoding and encoding JSON and other file formats with Codable"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For a newcomer to Hummingbird 2 and Swift, I feel that En/Decoding doesn't really tag onto what you want to do. People want to send/receive JSON, they "don't care" that this requires Codable.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer we fix the naming of encoding/decoding docs instead of repeating what is pretty much the same content in this JSON doc.

@Joannis Joannis requested a review from adam-fowler March 10, 2025 21:16
Copy link
Member

@adam-fowler adam-fowler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I happy with all the other changes. Still not convinced by JSON page. I've tried to ameliorate some of your concerns with #87. They make it a lot clearer that they are about JSON encoding/decoding

Copy link
Member

@adam-fowler adam-fowler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You've still got the json link in index.md

@adam-fowler adam-fowler merged commit 5336be2 into main Mar 18, 2025
1 check passed
@adam-fowler adam-fowler deleted the jo/clarifications branch March 18, 2025 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants